home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / wb-tools / shellbench / catalogs / translators.readme < prev    next >
Text File  |  1996-04-05  |  4KB  |  91 lines
  1.  
  2. Notes for Catalog Translators.
  3. ==============================
  4.  
  5. If you have translated catalogs before you probably know most of this
  6. already, but it's probably still worth glancing through it.
  7.  
  8. 1. You should work on the template file, xxx.ct. The xxx.cd file is
  9. the master and is supplied for reference purposes.
  10.  
  11. 2. In the xxx.ct file, remove the xxx.cd version string.
  12.  
  13. 3. Put your AmigaDOS version string after "## version". The current
  14. major version number is 2. You must use this, too.
  15.  
  16. 3. Put your language name after "## language", above.
  17.  
  18. 4. (Optional) Put an author chunk below "## codeset", something like:
  19. ## chunk AUTH Klingon catalog for xxx by Glurchh Splath (gspalth@starfleet.mil)
  20. This will get embedded in the resulting catalog file as an AUTH chunk
  21. by FlexCat. CatComp does not understand ## chunk, however.
  22.  
  23. 5. Enter your translations for the texts in the xxx.ct file:
  24.  
  25.  o Lines beginning with ';' are comments.
  26.  
  27.  o If you are updating a translation from the previous version:
  28.    '++' marks new entries, '##' changed entries, '--' deleted entries.
  29.  
  30.  o Each text has the ID followed by a blank line on which you should
  31.    enter your translation, followed by the original English text as
  32.    a handy reference (commented out), followed by any other comments I
  33.    may have added, usually enclosed in '<>'.
  34.  
  35.  o If a sentence or phrase doesn't translate literally, go ahead and
  36.    alter it to suit your language - it's only the meaning of it that
  37.    we're after.
  38.  
  39.  o A few entries may have restrictions on the length of the string -
  40.    check in the xxx.cd file where you will see the text ID followed by
  41.    '(/x/y)'. The 'x' is the minimum, 'y' the maximum number of
  42.    characters allowed. If the x,y values are omitted for a string,
  43.    there are no restrictions on the length of that entry.
  44.  
  45.  o In catalogs for BGUI/MUI programs, '\033c' is a code that centres
  46.    lines in the requester. Leave it at the beginning of messages with
  47.    more than one line, it is not needed if the message has only one
  48.    line.
  49.  
  50.  o In catalogs for BGUI/MUI programs, '\033dn' is a code that sets
  51.    the text colour to pen 'n'. You should include these codes at the
  52.    appropriate points, if present in the original message.
  53.  
  54.  o Codes like '%s' and '%lu' get values substituted for them when the
  55.    program runs. You must include all of these codes, in the same
  56.    order, in your translation at the appropriate points. A comment
  57.    will indicate what kind of value gets substituted for each code.
  58.  
  59.  o Put in the code '\n' when you want to start a new line. The '\'
  60.    character by itself at the end of a line means the text continues
  61.    on the next line with nothing in between.
  62.  
  63.  o Gadget labels (xxxLAB) usually have keyboard shortcuts. The
  64.    shortcut key is the one after the underscore character '_'. Do not
  65.    use shifted characters. Ensure you give all gadgets that appear on
  66.    the same page a unique shortcut. Put the shortcut key in the next
  67.    catalog entry (xxxKEY) as well.
  68.  
  69.  o It is technically possible to have a keyboard shortcut without an
  70.    associated underscored character in the label, but this should be
  71.    avoided as the shortcut is then not obvious.
  72.  
  73.  o Shortcut keys for menu labels should be uppercase. Changing the
  74.    default keys is discouraged, as this violates the Style Guide.
  75.  
  76. 6. Use a program like CatComp or FlexCat to convert the translation
  77. into a catalog file and test it out. If you don't have such a program,
  78. send the .ct file to me and I'll make a catalog out of it for you.
  79.  
  80. 7. When you're happy with it, send me the .ct file and tell me if you
  81. would like to update the translation for new versions of the program:
  82. I'll send them to you shortly before release.
  83.  
  84. Any questions, mail me: nmc@dircon.co.uk
  85. Thanks for your time and effort. I really appreciate it.
  86.  
  87. Nick
  88.  
  89.  
  90. $VER: Translators.readme 1.1 (5.4.96)
  91.